// Copyright (C) Kumo inc. and its affiliates.
// Author: Jeff.li lijippy@163.com
// All rights reserved.
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published
// by the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.
//


#pragma once

#include <pollux/common/memory/hash_string_allocator.h>
#include <pollux/functions/lib/aggregates/single_value_accumulator.h>
#include <pollux/vector/decoded_vector.h>

namespace kumo::pollux::functions::aggregate {
    /// Compare the new value of the DecodedVector at the given index with the value
    /// stored in the SingleValueAccumulator. Returns 0 if stored and new values are
    /// equal; <0 if stored value is less then new value; >0 if stored value is
    /// greater than new value.
    ///
    /// If nullHandlingMode is NullAsValue, nested nulls are handled as value. If
    /// nullHandlingMode is StopAtNull, it will throw an exception when complex
    /// type values contain nulls.
    /// Note, The default nullHandlingMode in Presto is StopAtNull while the
    /// default nullHandlingMode is NullAsValue in Spark.
    int32_t compare(
        const pollux::functions::aggregate::SingleValueAccumulator *accumulator,
        const DecodedVector &decoded,
        vector_size_t index,
        CompareFlags compareFlags);
} // namespace kumo::pollux::functions::aggregate
